TaxedAmount (SAP CC 4.1 Java APIs (Core Library))

java.lang.Object
- com.highdeal.tax.hci.TaxedAmount

All Implemented Interfaces:: XMLMarshallable

public class TaxedAmount
extends Object
implements XMLMarshallable

FOR INTERNAL USE ONLY - This class represents the taxed amount with its tax details.

This class is for internal use only. During the rating process, the SAP CC system executes a price plan and computes tax data.

A taxed amount data model is composed by:

The taxation module (tax system) used to calculate the tax
The gross amount flag
The tax amount
The total amount
The tax coefficient: (1 + (tax rate / 100))
The tax code: EZTAX_AREA (for EZTax), a country tax zone for VAT (FR, GB, ES, ...), NO_TAX, BY_RULE
The tax status (see the description of the TaxStatus enumeration)

See Also: TaxDetailModel

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="taxedAmount">
   <xs:complexType>
     <xs:sequence>
       <xs:element ref="taxDetail" minOccurs="0" maxOccurs="unbounded"/>
     </xs:sequence>
     <xs:attribute name="taxationModule" type="AccountTaxationModuleType" default="vatTaxationModule"/>
     <xs:attribute name="isGrossAmount" type="xs:boolean" default="false"/>
     <xs:attribute name="taxAmount" type="xs:decimal" default="0"/>
     <xs:attribute name="totalAmount" type="xs:decimal" default="0"/>
     <xs:attribute name="taxCoefficient" type="xs:decimal" default="1"/>
     <xs:attribute name="taxCode" type="xs:string" default="NO_TAX"/>
     <xs:attribute name="taxStatus" type="TaxStatusType" default="tsNoTax"/>
     <xs:attribute name="prepaidBalanceTaxationType" type="PrepaidBalanceTaxationTypeType" default="taxExcluded"/> <!-- the subscriber balance is tax included/excluded -->
     <xs:attribute name="useOldModel" type="xs:boolean" default="false"/>
   </xs:complexType>
 </xs:element>

<xs:simpleType name="PrepaidBalanceTaxationTypeType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="taxIncluded"/> <!-- postpaid receivable account -->
     <xs:enumeration value="taxExcluded"/> <!-- postpaid payable account (for partner)-->
   </xs:restriction>
 </xs:simpleType>

<xs:simpleType name="TaxStatusType">
   <xs:restriction base="xs:string">
     <xs:enumeration value="tsNoTax"/>
     <xs:enumeration value="tsForInfo"/>
     <xs:enumeration value="tsApplied"/>
     <xs:enumeration value="tsTaxExempted"/>
     <xs:enumeration value="tsTaxMissedForInfo"/>
     <xs:enumeration value="tsTaxMissedForApply"/>
     <xs:enumeration value="tsUnknown"/>
   </xs:restriction>
 </xs:simpleType>

Field Summary

Fields
Modifier and Type Field and Description

static int TAX_EXCLUDED
Type for postpaid tax included balance (default)

static int TAX_INCLUDED
Type for postpaid tax excluded balance

Fields
Modifier and Type	Field and Description
`static int`	`TAX_EXCLUDED` Type for postpaid tax included balance (default)
`static int`	`TAX_INCLUDED` Type for postpaid tax excluded balance

Constructor Summary

Constructors
Constructor and Description

TaxedAmount()
Builds an empty taxed amount object.

Constructors
Constructor and Description
`TaxedAmount()` Builds an empty taxed amount object.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addCharacterData(String cData)` Adds character data to the content element.
`void`	`addChild(String tagName, XMLMarshallable child)` Adds a child to the object, the `child` representing the marshallable object which must be added to the element.
`BigDecimal`	`getRoundedTotalAmount()` Gets the rounded amount.
`BigDecimal`	`getTaxAmount()` Gets the tax amount.
`com.highdeal.tax.Tax.TaxationModule`	`getTaxationModule()` Gets the tax sytem set for the account.
`String`	`getTaxCode()` Returns the tax code.
`BigDecimal`	`getTaxCoefficient()` Gets the tax coefficient.
`List<TaxDetailModel>`	`getTaxDetails()` Returns a list of `TaxDetailModel`.
`TaxStatus`	`getTaxStatus()` Gets the tax status.
`BigDecimal`	`getTotalAmount()` Gets the gross amount.
`boolean`	`isGrossAmount()` Gets the gross amount flag.
`boolean`	`isValid()` Returns true if the taxed amount is valid; Taxed amount is valid if it contains a tax amount and a valid tax detail if any.
`void`	`marshal(XMLOutputter output)` Gives an XML representation of this object, including its children.
`void`	`setAttributes(XMLAttributes atts)` Sets the attributes of the XML representation of the element being processed.
`void`	`setGrossAmount(boolean isGrossAmount)` Sets the gross amount flag.
`void`	`setRoundedTotalAmount(BigDecimal roundedtotalAmount)` Sets the rounded amount.
`void`	`setTaxAmount(BigDecimal taxAmount)` Sets the tax amount.
`void`	`setTaxationModule(com.highdeal.tax.Tax.TaxationModule taxationModule)` Sets the taxation module for the account.
`void`	`setTaxCode(String code)` Sets the tax code.
`void`	`setTaxCoefficient(BigDecimal taxCoef)` Sets the tax coefficient.
`void`	`setTaxStatus(TaxStatus taxStatus)` Sets the tax status.
`void`	`setTotalAmount(BigDecimal totalAmount)` Sets the gross amount.
`String`	`toString()` Returns a string representation of the taxed amount.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - TAX_EXCLUDED
```
public static final int TAX_EXCLUDED
```
    Type for postpaid tax included balance (default)
    
    See Also:
    
    Constant Field Values
  - TAX_INCLUDED
```
public static final int TAX_INCLUDED
```
    Type for postpaid tax excluded balance
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - TaxedAmount
```
public TaxedAmount()
```
    Builds an empty taxed amount object.
- Method Detail
  - getTaxationModule
```
public com.highdeal.tax.Tax.TaxationModule getTaxationModule()
```
    Gets the tax sytem set for the account.
    
    Returns:
    
    The tax system (previously named taxation module) for the account
    
    See Also:
    
    Tax.TaxationModule
  - setTaxationModule
```
public void setTaxationModule(com.highdeal.tax.Tax.TaxationModule taxationModule)
```
    Sets the taxation module for the account.
    
    Parameters:
    
    taxationModule - The tax system set for this account
    
    See Also:
    
    to know available modules to tax this account
  - isGrossAmount
```
public boolean isGrossAmount()
```
    Gets the gross amount flag.
    
    Returns:
    
    The gross amount flag
  - setGrossAmount
```
public void setGrossAmount(boolean isGrossAmount)
```
    Sets the gross amount flag.
    
    Parameters:
    
    isGrossAmount - The gross amount flag
  - getTaxAmount
```
public BigDecimal getTaxAmount()
```
    Gets the tax amount.
    
    Returns:
    
    The tax amount
  - setTaxAmount
```
public void setTaxAmount(BigDecimal taxAmount)
```
    Sets the tax amount.
    
    Parameters:
    
    taxAmount - The tax amount
  - getTotalAmount
```
public BigDecimal getTotalAmount()
```
    Gets the gross amount.
    
    Returns:
    
    The gross amount
  - setTotalAmount
```
public void setTotalAmount(BigDecimal totalAmount)
```
    Sets the gross amount.
    
    Parameters:
    
    totalAmount - The gross amount
  - getRoundedTotalAmount
```
public BigDecimal getRoundedTotalAmount()
```
    Gets the rounded amount.
    
    Returns:
    
    the rounded amount.
  - setRoundedTotalAmount
```
public void setRoundedTotalAmount(BigDecimal roundedtotalAmount)
```
    Sets the rounded amount.
    
    Parameters:
    
    roundedtotalAmount - the rounded amount.
  - getTaxCoefficient
```
public BigDecimal getTaxCoefficient()
```
    Gets the tax coefficient.
    
    Returns:
    
    The tax coefficient
  - setTaxCoefficient
```
public void setTaxCoefficient(BigDecimal taxCoef)
```
    Sets the tax coefficient.
    
    Parameters:
    
    taxCoef - The tax coefficient
  - getTaxCode
```
public String getTaxCode()
```
    Returns the tax code.
    
    Returns:
    
    The tax code
  - setTaxCode
```
public void setTaxCode(String code)
```
    Sets the tax code.
    
    Parameters:
    
    code - The tax code
  - getTaxStatus
```
public TaxStatus getTaxStatus()
```
    Gets the tax status.
    
    Returns:
    
    The tax status
  - setTaxStatus
```
public void setTaxStatus(TaxStatus taxStatus)
```
    Sets the tax status.
    
    Parameters:
    
    taxStatus - The tax status
    
    See Also:
    
    TaxStatus
  - getTaxDetails
```
public List<TaxDetailModel> getTaxDetails()
```
    Returns a list of TaxDetailModel.
    
    Returns:
    
    A list of TaxDetailModel
  - isValid
```
public boolean isValid()
```
    Returns true if the taxed amount is valid; Taxed amount is valid if it contains a tax amount and a valid tax detail if any.
    
    Returns:
    
    true if the taxed amount is valid, false otherwise
  - toString
```
public String toString()
```
    Returns a string representation of the taxed amount.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of the taxed amount
  - setAttributes
```
public void setAttributes(XMLAttributes atts)
```
    Description copied from interface: XMLMarshallable
    
    Sets the attributes of the XML representation of the element being processed.
    
    Specified by:
    
    setAttributes in interface XMLMarshallable
    
    Parameters:
    
    atts - The XML attributes of the current element
  - addChild
```
public void addChild(String tagName,
                     XMLMarshallable child)
```
    Description copied from interface: XMLMarshallable
    
    Adds a child to the object, the child representing the marshallable object which must be added to the element.
    
    Specified by:
    
    addChild in interface XMLMarshallable
    
    Parameters:
    
    tagName - The name of tag for the child
    
    child - The child to be added
  - addCharacterData
```
public void addCharacterData(String cData)
```
    Description copied from interface: XMLMarshallable
    
    Adds character data to the content element.
    
    Specified by:
    
    addCharacterData in interface XMLMarshallable
    
    Parameters:
    
    cData - The character data to be added
  - marshal
```
public void marshal(XMLOutputter output)
```
    Description copied from interface: XMLMarshallable
    
    Gives an XML representation of this object, including its children.
    
    Specified by:
    
    marshal in interface XMLMarshallable
    
    Parameters:
    
    output - The XML output to marshal the object into

Class TaxedAmount

XML API for HCI

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TAX_EXCLUDED

TAX_INCLUDED

Constructor Detail

TaxedAmount

Method Detail

getTaxationModule

setTaxationModule

isGrossAmount

setGrossAmount

getTaxAmount

setTaxAmount

getTotalAmount

setTotalAmount

getRoundedTotalAmount

setRoundedTotalAmount

getTaxCoefficient

setTaxCoefficient

getTaxCode

setTaxCode

getTaxStatus

setTaxStatus

getTaxDetails

isValid

toString

setAttributes

addChild

addCharacterData

marshal